/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr.impl;

import java.util.Calendar;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.wsa.WsaEnvelopeCreator;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrAckOperations;
import cgl.narada.wsinfra.wsr.WsrConstants;
import cgl.narada.wsinfra.wsr.WsrElementAddition;
import cgl.narada.wsinfra.wsr.WsrElementCreation;
import cgl.narada.wsinfra.wsr.WsrNodeUtils;
import cgl.narada.wsinfra.wsr.WsrProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrSourceGroupMonitor;
import cgl.narada.wsinfra.wsr.storage.WsrGroupInfoStorageOperations;
import cgl.narada.wsinfra.wsr.storage.WsrProtocolStorageOperations;
import cgl.narada.wsinfra.wsr.storage.WsrStorageException;
import cgl.narada.wsinfra.wsr.storage.WsrStorageService;
import cgl.narada.wsinfra.wsr.storage.impl.WsrGroupInfoImpl;
import cgl.narada.wsinfra.wsr.storage.impl.WsrGroupTerminationInfoImpl;
import cgl.narada.wsinfra.wsr.storage.impl.WsrStorageWidgetImpl;

/** 
 * @author Sima patel
 * $Date: 2005/05/04 18:05:34 $
 * $Revision: 1.5 $
 * 
 * This processor processes Groups and determines if 
    (a) Acknowledgements/Retransmissions need to be issued.
    (b) See if the Inactivity timeout on a group has expired, if so
    proceed to terminate the group. 
    
*/


public class WsrSourceGroupMonitorImpl extends Thread implements WsrSourceGroupMonitor {
  
	private SoapEnvelopeConversion soapEnvelopeConversion;
    private WsrAckOperations wsrAckOperations;
    private WsrElementAddition wsrElementAddition;
    private WsrElementCreation wsrElementCreation;
    private WsrFaultsImpl wsrFaultsImpl;
    private WsrStorageService wsrStorageService;
    private WsrProtocolStorageOperations wsrProtocolStorageOperations;
    private WsrGroupInfoStorageOperations wsrGroupInfoStorageOperations;
    private WsrNodeUtils wsrNodeUtils;
    private WsaEnvelopeCreator wsaEnvelopeCreator;
    
    private WsrSourceGroupTerminationImpl wsrSourceGroupTerminationImpl;
    private WsrUtil wsrUtil;
    private boolean debug = true;
    private WsMessageFlow wsMessageFlow;
    private boolean keepRunning = true;
    private boolean isRunning = false;
    private long SLEEP_INTERVAL = 15000;
    private String moduleName = "WsrSourceGroupMonitor: ";
    
    protected WsrSourceGroupMonitorImpl(String configInfo,WsMessageFlow wsMessageFlow) 
              throws WsrStorageException, DeploymentException{
        this.wsMessageFlow = wsMessageFlow;
        System.out.println(moduleName + "Using configuration file [" + configInfo 
                           + "]");
        wsrStorageService = WsrStorageService.getSourceStorageServiceInstance(configInfo);
        wsrProtocolStorageOperations = 
                            wsrStorageService.getWsrProtocolStorageOperations();
        wsrGroupInfoStorageOperations = 
                           wsrStorageService.getWsrGroupInfoStorageOperations(); 
        wsrSourceGroupTerminationImpl = WsrSourceGroupTerminationImpl.getInstance();
        wsrUtil = WsrUtil.getInstance();
        wsrSourceGroupTerminationImpl.initialize(wsrStorageService);
        wsrAckOperations = WsrProcessingFactory.getWsrAckOperations();
        wsrElementAddition = WsrProcessingFactory.getWsrElementAddition();
        wsrFaultsImpl = WsrFaultsImpl.getInstance();
        wsrElementCreation = WsrProcessingFactory.getWsrElementCreation();
        wsrNodeUtils = WsrProcessingFactory.getWsrNodeUtils();
        wsaEnvelopeCreator = WsaProcessingFactory.getWsaEnvelopeCreator();
        System.out.println(moduleName + "Initializations complete ...");
	}
   
    /* Begin services related to Group monitoring viz. issue acknowledgements
    and initiate retransmissions for Groups. */
    public void startServices() {
        keepRunning = true;
        if(!isRunning){
          start();
          isRunning = true;
	}
    }
  
    /* Stop services related to group monitoring. */
    public void stopServices() {
        keepRunning = false;
    }

    public void run() {  
        while(keepRunning) {
            try {
                sleep(SLEEP_INTERVAL);
                cycleThroughGroups();
            } catch (MessageFlowException mfe) {
                System.out.println(moduleName + "Problems processing Groups. " + 
                                   "MessageFlow problems " + mfe);
                mfe.printStackTrace();
                continue;
            } catch (WsrStorageException wste) {
                System.out.println(moduleName + "Problems processing Groups " 
                                   + wste);
                wste.printStackTrace();
                printTerminationInfo();
                break;
            } catch (InterruptedException e) {
                System.out.println(moduleName + "Problems sleeping " + e);
                printTerminationInfo();
                break;
            }
        }/* end while(keepLooping) */
        isRunning = false;
        System.out.println(moduleName + "The thread is shutting down.");
    }

    private void printTerminationInfo() {
        System.out.println(moduleName + "Because of an error, " +
                           " Processing of this "
                           + "thread has been terrminated! No further " + 
                           "retransmissions/acks will be issued.");
    }
  
    private void cycleThroughGroups() throws MessageFlowException, 
                                             WsrStorageException {
        String[] sentGroups = 
                        wsrGroupInfoStorageOperations.getListOfAllGroups(true);
        System.out.println(moduleName + "Processing sent Groups ");
        if (sentGroups == null) {
            if (debug) {
                System.out.println(moduleName + 
                                            "No active Sent Groups to process");
            }
        }
        if (sentGroups != null) {
        	System.out.println(moduleName+"Processing retransmissions ");
            for (int i= 0; i < sentGroups.length; i++) {
                String _groupId = sentGroups[i];
                              
                
                WsrGroupInfoImpl _wsrGroupInfoImpl = 
                  wsrGroupInfoStorageOperations.getGroupInfoUsingGroupId(
                                                                      _groupId);
                boolean messagesAvailable=checkIfMessagesAvailable(
                                                             _wsrGroupInfoImpl);
		System.out.println("messages are available for retransmission:"+ messagesAvailable);
               
                if (messagesAvailable) {
                	
                    checkToIssueRetransmissions(_wsrGroupInfoImpl);
                }
                System.out.println("Processing Group Termination of sent Group");
                wsrSourceGroupTerminationImpl.processGroupTermination(_groupId);
            }
        }
        
      }
    /* Checks to see if any messages have been stored for this Group in
    question. */
    public boolean checkIfMessagesAvailable(WsrGroupInfoImpl wsrGroupInfoImpl)
                   throws WsrStorageException {
        String groupId = wsrGroupInfoImpl.getGroupId();
        boolean hasStoredElements = 
                wsrProtocolStorageOperations.hasStoredElements(groupId);
        return hasStoredElements;
    }
  
    /* This method checks to see if retransmissions need to be issued on the
    specified group. If a need arises retransmissions are issued and
    the retransmission interval is reset. */
    public void checkToIssueRetransmissions(WsrGroupInfoImpl wsrGroupInfoImpl) 
                throws WsrStorageException, MessageFlowException  {
        String groupId = wsrGroupInfoImpl.getGroupId();
        WsrGroupTerminationInfoImpl wsrGroupTerminatinInfoImpl=
	   		wsrProtocolStorageOperations.getGroupTerminationInfo(groupId);
        long[] sequenceNumbersNotAcked =
          wsrProtocolStorageOperations.getUnacknowledgedSequenceNumbers(groupId);
        if (sequenceNumbersNotAcked == null) {
            System.out.println(moduleName + "No sequence numbers on Group [" +
                               groupId + "] need to be Retransmitted");
            return;
        }
        WsrStorageWidgetImpl[] widgetsToRetransmit = 
          wsrProtocolStorageOperations.getStoredElements(groupId, 
                                                       sequenceNumbersNotAcked);

        if (widgetsToRetransmit == null) {
            System.out.println(moduleName + 
                                       "Widgets obtained for Retransmission " +
                          "are NULL. This should NOT have been the case under" +
                          "ANY circumstance");
            return;
        }
        int numOfWidgetsRetransmitted = widgetsToRetransmit.length;
        
        for (int i=0; i < numOfWidgetsRetransmitted; i++) {
        	Calendar messageExpiryTime = 
        		         widgetsToRetransmit[i].getMessageExpiryTime();
        	if(wsrUtil.isExpiryTimePassed(messageExpiryTime)){
        	       wsrGroupTerminatinInfoImpl.setMessageExpired(true);
        	   }else {
        	   	byte numberofretries = widgetsToRetransmit[i].getNumberOfRetries();
        	   	   if( numberofretries < 3){
        	   	   	
        	   	   		if(widgetsToRetransmit[i].getRetransmissionTime() 
        	   	   				<= System.currentTimeMillis()){
          	           EnvelopeDocument envelopeDocument = 
          	           				widgetsToRetransmit[i].getEnvelope(); 
          	           
          	           wsrProtocolStorageOperations.resetRetransmissionTime(
          	           									widgetsToRetransmit[i],
                                              System.currentTimeMillis()+300000);
          	           wsrProtocolStorageOperations.resetNumberOfRetries(
          	           									widgetsToRetransmit[i],
														(byte)(numberofretries+1));
          	           retransmitMessage(widgetsToRetransmit[i]);
   		           
        	   	   		}
        	   	   	
        	   	   }else{
        	   	   	widgetsToRetransmit[i].setMessageStatus(WsrConstants.MESSAGE_FAULTED);
        	   	   	widgetsToRetransmit[i].setMessageFault(
        	   	    wsrFaultsImpl.getPermenentProcessingFailure());
        	   	   		wsrProtocolStorageOperations.store(widgetsToRetransmit[i]);
        	   	   }        	       
            }           
            
        }
       
    }
  
    private void retransmitMessage(WsrStorageWidgetImpl wsrStorageWidgetImpl) 
                 throws MessageFlowException {
       
        EnvelopeDocument retransmitDocument = wsrStorageWidgetImpl.getEnvelope();

        enrouteToNetwork(retransmitDocument);
    } 
    private void enrouteToNetwork(EnvelopeDocument envelopeDocument)
    throws MessageFlowException { 
    
    	SoapEnvelopeConversion soapEnvelopeConversion = 
    		SoapEnvelopeConversion.getInstance();
    	SOAPMessage soapMessage = null;
    	try {
    		soapMessage =  soapEnvelopeConversion.getSOAPMessage(envelopeDocument);
    	} catch (ProcessingException ex) {
    		String errorReport ="Problems converting to javax.xml.SOAPMessage\n"
    			+ ex.toString();
    		throw new MessageFlowException(errorReport);
    	}
    	wsMessageFlow.enrouteToNetwork(soapMessage);
    }
   
}
